<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sysclk__clk__timer__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sysclk.html">SysClk       (System Clock)</a> &raquo; <a class="el" href="group__group__sysclk__clk__timer.html">Timer Clock</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4708822284fdca8103746e04e071f829"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a> (<a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a> source)</td></tr>
<tr class="memdesc:ga4708822284fdca8103746e04e071f829"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the source for the timer clock (clk_timer).  <a href="#ga4708822284fdca8103746e04e071f829">More...</a><br /></td></tr>
<tr class="separator:ga4708822284fdca8103746e04e071f829"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11eae81c891454917909bea5de9bc9a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga11eae81c891454917909bea5de9bc9a7">Cy_SysClk_ClkTimerGetSource</a> (void)</td></tr>
<tr class="memdesc:ga11eae81c891454917909bea5de9bc9a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the source for the timer clock (clk_timer).  <a href="#ga11eae81c891454917909bea5de9bc9a7">More...</a><br /></td></tr>
<tr class="separator:ga11eae81c891454917909bea5de9bc9a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga47723df14931fa6403b7d3948dec3857"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga47723df14931fa6403b7d3948dec3857">Cy_SysClk_ClkTimerSetDivider</a> (uint8_t divider)</td></tr>
<tr class="memdesc:ga47723df14931fa6403b7d3948dec3857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the divider for the timer clock (clk_timer).  <a href="#ga47723df14931fa6403b7d3948dec3857">More...</a><br /></td></tr>
<tr class="separator:ga47723df14931fa6403b7d3948dec3857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37599d3c7ed1d0433565e4ce66351bcc"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga37599d3c7ed1d0433565e4ce66351bcc">Cy_SysClk_ClkTimerGetDivider</a> (void)</td></tr>
<tr class="memdesc:ga37599d3c7ed1d0433565e4ce66351bcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the divider value for the timer clock (clk_timer).  <a href="#ga37599d3c7ed1d0433565e4ce66351bcc">More...</a><br /></td></tr>
<tr class="separator:ga37599d3c7ed1d0433565e4ce66351bcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c024720aee53bd450eb68377a35bbf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga3c024720aee53bd450eb68377a35bbf6">Cy_SysClk_ClkTimerEnable</a> (void)</td></tr>
<tr class="memdesc:ga3c024720aee53bd450eb68377a35bbf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the timer clock (clk_timer).  <a href="#ga3c024720aee53bd450eb68377a35bbf6">More...</a><br /></td></tr>
<tr class="separator:ga3c024720aee53bd450eb68377a35bbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa442df3e80e5c2dc763508731b155876"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#gaa442df3e80e5c2dc763508731b155876">Cy_SysClk_ClkTimerDisable</a> (void)</td></tr>
<tr class="memdesc:gaa442df3e80e5c2dc763508731b155876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the timer clock (clk_timer).  <a href="#gaa442df3e80e5c2dc763508731b155876">More...</a><br /></td></tr>
<tr class="separator:gaa442df3e80e5c2dc763508731b155876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga34ffff27beaafa7a391f2aac5cf38bfd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga34ffff27beaafa7a391f2aac5cf38bfd">Cy_SysClk_ClkTimerIsEnabled</a> (void)</td></tr>
<tr class="memdesc:ga34ffff27beaafa7a391f2aac5cf38bfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the Enabled/Disabled status of the Timer.  <a href="#ga34ffff27beaafa7a391f2aac5cf38bfd">More...</a><br /></td></tr>
<tr class="separator:ga34ffff27beaafa7a391f2aac5cf38bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9fa2ca0beada63a72bdc86dae9e5896"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__timer__funcs.html#gaa9fa2ca0beada63a72bdc86dae9e5896">Cy_SysClk_ClkTimerGetFrequency</a> (void)</td></tr>
<tr class="memdesc:gaa9fa2ca0beada63a72bdc86dae9e5896"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the frequency of the timer clock (clk_timer).  <a href="#gaa9fa2ca0beada63a72bdc86dae9e5896">More...</a><br /></td></tr>
<tr class="separator:gaa9fa2ca0beada63a72bdc86dae9e5896"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga4708822284fdca8103746e04e071f829"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4708822284fdca8103746e04e071f829">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerSetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkTimerSetSource </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a>&#160;</td>
          <td class="paramname"><em>source</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the source for the timer clock (clk_timer). </p>
<p>The timer clock can be used as a source for SYSTICK as an alternate clock and one or more of the energy profiler counters.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">source</td><td><a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The timer clock source needs to be updated to HFCLK0. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040daae7d2108717f298c79173c9e22a9efa3">CY_SYSCLK_CLKTIMER_IN_HF0_NODIV</a> != <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga11eae81c891454917909bea5de9bc9a7">Cy_SysClk_ClkTimerGetSource</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040daae7d2108717f298c79173c9e22a9efa3">CY_SYSCLK_CLKTIMER_IN_HF0_NODIV</a>);</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga11eae81c891454917909bea5de9bc9a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11eae81c891454917909bea5de9bc9a7">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerGetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a> Cy_SysClk_ClkTimerGetSource </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the source for the timer clock (clk_timer). </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__clk__timer__enums.html#ga86912bed27349c7e5c53315a84cd040d">cy_en_clktimer_in_sources_t</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The timer clock source needs to be updated to HFCLK0. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040daae7d2108717f298c79173c9e22a9efa3">CY_SYSCLK_CLKTIMER_IN_HF0_NODIV</a> != <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga11eae81c891454917909bea5de9bc9a7">Cy_SysClk_ClkTimerGetSource</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040daae7d2108717f298c79173c9e22a9efa3">CY_SYSCLK_CLKTIMER_IN_HF0_NODIV</a>);</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga47723df14931fa6403b7d3948dec3857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga47723df14931fa6403b7d3948dec3857">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerSetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkTimerSetDivider </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>divider</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the divider for the timer clock (clk_timer). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">divider</td><td>Divider value; valid range is 0 to 255. Divides the selected source (<a class="el" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a>) by the (value + 1).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Do not change the divider value while the timer clock is enabled.</dd>
<dd>
This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The timer divider needs to be updated to 64. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(63u != <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga37599d3c7ed1d0433565e4ce66351bcc">Cy_SysClk_ClkTimerGetDivider</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga47723df14931fa6403b7d3948dec3857">Cy_SysClk_ClkTimerSetDivider</a>(63u); <span class="comment">/* divider = value + 1 */</span></div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga37599d3c7ed1d0433565e4ce66351bcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga37599d3c7ed1d0433565e4ce66351bcc">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerGetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t Cy_SysClk_ClkTimerGetDivider </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the divider value for the timer clock (clk_timer). </p>
<dl class="section return"><dt>Returns</dt><dd>The divider value</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The timer divider needs to be updated to 64. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(63u != <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga37599d3c7ed1d0433565e4ce66351bcc">Cy_SysClk_ClkTimerGetDivider</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga47723df14931fa6403b7d3948dec3857">Cy_SysClk_ClkTimerSetDivider</a>(63u); <span class="comment">/* divider = value + 1 */</span></div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga3c024720aee53bd450eb68377a35bbf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c024720aee53bd450eb68377a35bbf6">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkTimerEnable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the timer clock (clk_timer). </p>
<p>The timer clock can be used as a source for SYSTICK and one or more of the energy profiler counters.</p>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Timer clock needs to operate at HFCLK/32. */</span></div><div class="line"></div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040da1624370101fb5836357e8ed40fbc62f0">CY_SYSCLK_CLKTIMER_IN_HF0_DIV8</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga47723df14931fa6403b7d3948dec3857">Cy_SysClk_ClkTimerSetDivider</a>(3u); <span class="comment">/* divider = value + 1 */</span></div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga3c024720aee53bd450eb68377a35bbf6">Cy_SysClk_ClkTimerEnable</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Use the Timer clock as a source for the alternative ARM SysTick clock or</span></div><div class="line"><span class="comment">       for an Energy Profile counter clock. */</span></div><div class="line"></div><div class="line">    <span class="comment">/* In case if there is a need to get the timer clock frequency */</span></div><div class="line">    uint32_t timerClkFreq = <a class="code" href="group__group__sysclk__clk__timer__funcs.html#gaa9fa2ca0beada63a72bdc86dae9e5896">Cy_SysClk_ClkTimerGetFrequency</a>();</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gaa442df3e80e5c2dc763508731b155876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa442df3e80e5c2dc763508731b155876">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkTimerDisable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the timer clock (clk_timer). </p>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Timer clock is no longer required and needs to be disabled.</span></div><div class="line"><span class="comment">                 All peripherals clocked using this source are disabled. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga34ffff27beaafa7a391f2aac5cf38bfd">Cy_SysClk_ClkTimerIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#gaa442df3e80e5c2dc763508731b155876">Cy_SysClk_ClkTimerDisable</a>();</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga34ffff27beaafa7a391f2aac5cf38bfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga34ffff27beaafa7a391f2aac5cf38bfd">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerIsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_ClkTimerIsEnabled </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the Enabled/Disabled status of the Timer. </p>
<dl class="section return"><dt>Returns</dt><dd>Boolean status of Timer: true - Enabled, false - Disabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Timer clock is no longer required and needs to be disabled.</span></div><div class="line"><span class="comment">                 All peripherals clocked using this source are disabled. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga34ffff27beaafa7a391f2aac5cf38bfd">Cy_SysClk_ClkTimerIsEnabled</a>())</div><div class="line">    {</div><div class="line">        <a class="code" href="group__group__sysclk__clk__timer__funcs.html#gaa442df3e80e5c2dc763508731b155876">Cy_SysClk_ClkTimerDisable</a>();</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices. </dd></dl>

</div>
</div>
<a id="gaa9fa2ca0beada63a72bdc86dae9e5896"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa9fa2ca0beada63a72bdc86dae9e5896">&#9670;&nbsp;</a></span>Cy_SysClk_ClkTimerGetFrequency()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_ClkTimerGetFrequency </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the frequency of the timer clock (clk_timer). </p>
<dl class="section note"><dt>Note</dt><dd>If the the timer clock is not enabled - a zero frequency is reported.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Timer clock needs to operate at HFCLK/32. */</span></div><div class="line"></div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga4708822284fdca8103746e04e071f829">Cy_SysClk_ClkTimerSetSource</a>(<a class="code" href="group__group__sysclk__clk__timer__enums.html#gga86912bed27349c7e5c53315a84cd040da1624370101fb5836357e8ed40fbc62f0">CY_SYSCLK_CLKTIMER_IN_HF0_DIV8</a>);</div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga47723df14931fa6403b7d3948dec3857">Cy_SysClk_ClkTimerSetDivider</a>(3u); <span class="comment">/* divider = value + 1 */</span></div><div class="line">    <a class="code" href="group__group__sysclk__clk__timer__funcs.html#ga3c024720aee53bd450eb68377a35bbf6">Cy_SysClk_ClkTimerEnable</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Use the Timer clock as a source for the alternative ARM SysTick clock or</span></div><div class="line"><span class="comment">       for an Energy Profile counter clock. */</span></div><div class="line"></div><div class="line">    <span class="comment">/* In case if there is a need to get the timer clock frequency */</span></div><div class="line">    uint32_t timerClkFreq = <a class="code" href="group__group__sysclk__clk__timer__funcs.html#gaa9fa2ca0beada63a72bdc86dae9e5896">Cy_SysClk_ClkTimerGetFrequency</a>();</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (excluding TVIIBE) devices. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
